<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arduino MIDI File Parser: src/MidiFileParserCommon.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Arduino MIDI File Parser
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">MidiFileParserCommon.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#include &quot;RingBuffer.h&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="keyword">enum</span> midi_parser_status {</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;  MIDI_PARSER_EOB = -2,</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;  MIDI_PARSER_ERROR = -1,</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;  MIDI_PARSER_INIT = 0,</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;  MIDI_PARSER_HEADER = 1,</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;  MIDI_PARSER_TRACK = 2,</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;  MIDI_PARSER_TRACK_MIDI = 3,</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;  MIDI_PARSER_TRACK_META = 4,</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;  MIDI_PARSER_TRACK_SYSEX = 5,</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;};</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="keyword">enum</span> midi_file_format {</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;  MIDI_FILE_FORMAT_SINGLE_TRACK = 0,</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;  MIDI_FILE_FORMAT_MULTIPLE_TRACKS = 1,</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;  MIDI_FILE_FORMAT_MULTIPLE_SONGS = 2,</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;};</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structmidi__header.html">   28</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmidi__header.html">midi_header</a> {</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  int32_t size;</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;  uint16_t format;</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;  int16_t tracks_count;</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  int16_t time_division;</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;};</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structmidi__track.html">   38</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmidi__track.html">midi_track</a> {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  int32_t size;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;};</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">enum</span> midi_status {</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  MIDI_STATUS_NA = 0x0,</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  MIDI_STATUS_NOTE_OFF = 0x8,</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  MIDI_STATUS_NOTE_ON = 0x9,</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  MIDI_STATUS_NOTE_AT = 0xA, <span class="comment">// after touch</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  MIDI_STATUS_CC = 0xB,      <span class="comment">// control change</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  MIDI_STATUS_PGM_CHANGE = 0xC,</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  MIDI_STATUS_CHANNEL_AT = 0xD, <span class="comment">// after touch</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  MIDI_STATUS_PITCH_BEND = 0xE,</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;};</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="keyword">enum</span> midi_meta {</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  MIDI_META_SEQ_NUM = 0x00,</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  MIDI_META_TEXT = 0x01,</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  MIDI_META_COPYRIGHT = 0x02,</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  MIDI_META_TRACK_NAME = 0x03,</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  MIDI_META_INSTRUMENT_NAME = 0x04,</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  MIDI_META_LYRICS = 0x05,</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  MIDI_META_MAKER = 0x06,</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  MIDI_META_CUE_POINT = 0x07,</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  MIDI_META_CHANNEL_PREFIX = 0x20,</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;  MIDI_META_END_OF_TRACK = 0x2F,</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  MIDI_META_SET_TEMPO = 0x51,</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  MIDI_META_SMPTE_OFFSET = 0x54,</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  MIDI_META_TIME_SIGNATURE = 0x58,</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  MIDI_META_KEY_SIGNATURE = 0x59,</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  MIDI_META_SEQ_SPECIFIC = 0x7F,</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;};</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structmidi__midi__event.html">   79</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmidi__midi__event.html">midi_midi_event</a> {</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <span class="keywordtype">unsigned</span> status : 4;</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  <span class="keywordtype">unsigned</span> channel : 4;</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  uint8_t param1;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  uint8_t param2;</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;};</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structmidi__meta__event.html">   90</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmidi__meta__event.html">midi_meta_event</a> {</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  uint8_t type;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;  int32_t length;</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  <span class="keyword">const</span> uint8_t *bytes; <span class="comment">// reference to the input buffer</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;};</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="structmidi__sysex__event.html">  100</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmidi__sysex__event.html">midi_sysex_event</a> {</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  uint8_t sysex;</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  uint8_t type;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  int32_t length;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  <span class="keyword">const</span> uint8_t *bytes; <span class="comment">// reference to the input buffer</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;};</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="structmidi__parser__state.html">  111</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmidi__parser__state.html">midi_parser_state</a> {</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;  <span class="keyword">enum</span> midi_parser_status status;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  <span class="keyword">enum</span> midi_parser_status status_internal;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;  <span class="keyword">enum</span> midi_status buffered_status;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  <span class="keywordtype">unsigned</span> buffered_channel;</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160; </div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  <span class="comment">/* input buffer */</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;  <a class="code" href="classRingBuffer.html">RingBuffer</a> in;</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;  <span class="comment">/* result */</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;  int64_t vtime;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;  <span class="keyword">struct </span><a class="code" href="structmidi__header.html">midi_header</a> header;</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;  <span class="keyword">struct </span><a class="code" href="structmidi__track.html">midi_track</a> track;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;  <span class="keyword">struct </span><a class="code" href="structmidi__midi__event.html">midi_midi_event</a> midi;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;  <span class="keyword">struct </span><a class="code" href="structmidi__meta__event.html">midi_meta_event</a> meta;</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;  <span class="keyword">struct </span><a class="code" href="structmidi__sysex__event.html">midi_sysex_event</a> sysex;</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;};</div>
<div class="ttc" id="aclassRingBuffer_html"><div class="ttname"><a href="classRingBuffer.html">RingBuffer</a></div><div class="ttdoc">RingBuffer that supports extensive peek operations to access and compare the next values.</div><div class="ttdef"><b>Definition:</b> RingBuffer.h:14</div></div>
<div class="ttc" id="astructmidi__header_html"><div class="ttname"><a href="structmidi__header.html">midi_header</a></div><div class="ttdoc">MIDI Header Information.</div><div class="ttdef"><b>Definition:</b> MidiFileParserCommon.h:28</div></div>
<div class="ttc" id="astructmidi__meta__event_html"><div class="ttname"><a href="structmidi__meta__event.html">midi_meta_event</a></div><div class="ttdoc">MIDI Metadata Event Information.</div><div class="ttdef"><b>Definition:</b> MidiFileParserCommon.h:90</div></div>
<div class="ttc" id="astructmidi__midi__event_html"><div class="ttname"><a href="structmidi__midi__event.html">midi_midi_event</a></div><div class="ttdoc">MIDI Event Information.</div><div class="ttdef"><b>Definition:</b> MidiFileParserCommon.h:79</div></div>
<div class="ttc" id="astructmidi__parser__state_html"><div class="ttname"><a href="structmidi__parser__state.html">midi_parser_state</a></div><div class="ttdoc">MIDI Parser State Information.</div><div class="ttdef"><b>Definition:</b> MidiFileParserCommon.h:111</div></div>
<div class="ttc" id="astructmidi__sysex__event_html"><div class="ttname"><a href="structmidi__sysex__event.html">midi_sysex_event</a></div><div class="ttdoc">MIDI Sysex Event Information.</div><div class="ttdef"><b>Definition:</b> MidiFileParserCommon.h:100</div></div>
<div class="ttc" id="astructmidi__track_html"><div class="ttname"><a href="structmidi__track.html">midi_track</a></div><div class="ttdoc">MIDI Track Information.</div><div class="ttdef"><b>Definition:</b> MidiFileParserCommon.h:38</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
